<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span>/*<a name="line.1"></a>
<span class="sourceLineNo">002</span> * Copyright (C) 2010 Zhenya Leonov<a name="line.2"></a>
<span class="sourceLineNo">003</span> *<a name="line.3"></a>
<span class="sourceLineNo">004</span> * Licensed under the Apache License, Version 2.0 (the "License");<a name="line.4"></a>
<span class="sourceLineNo">005</span> * you may not use this file except in compliance with the License.<a name="line.5"></a>
<span class="sourceLineNo">006</span> * You may obtain a copy of the License at<a name="line.6"></a>
<span class="sourceLineNo">007</span> *<a name="line.7"></a>
<span class="sourceLineNo">008</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.8"></a>
<span class="sourceLineNo">009</span> *<a name="line.9"></a>
<span class="sourceLineNo">010</span> * Unless required by applicable law or agreed to in writing, software<a name="line.10"></a>
<span class="sourceLineNo">011</span> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.11"></a>
<span class="sourceLineNo">012</span> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.12"></a>
<span class="sourceLineNo">013</span> * See the License for the specific language governing permissions and<a name="line.13"></a>
<span class="sourceLineNo">014</span> * limitations under the License.<a name="line.14"></a>
<span class="sourceLineNo">015</span> */<a name="line.15"></a>
<span class="sourceLineNo">016</span><a name="line.16"></a>
<span class="sourceLineNo">017</span>package com.palamida.util.collect;<a name="line.17"></a>
<span class="sourceLineNo">018</span><a name="line.18"></a>
<span class="sourceLineNo">019</span>import java.util.Collection;<a name="line.19"></a>
<span class="sourceLineNo">020</span>import java.util.Comparator;<a name="line.20"></a>
<span class="sourceLineNo">021</span><a name="line.21"></a>
<span class="sourceLineNo">022</span>/**<a name="line.22"></a>
<span class="sourceLineNo">023</span> * A {@link Collection} which maintains its elements in &lt;i&gt;sorted&lt;/i&gt; order.<a name="line.23"></a>
<span class="sourceLineNo">024</span> * This interface is the root of all &lt;i&gt;sorted&lt;/i&gt; collection interfaces and<a name="line.24"></a>
<span class="sourceLineNo">025</span> * implementations.<a name="line.25"></a>
<span class="sourceLineNo">026</span> * &lt;p&gt;<a name="line.26"></a>
<span class="sourceLineNo">027</span> * Classes which implement this interface (directly or indirectly) are required<a name="line.27"></a>
<span class="sourceLineNo">028</span> * to implement the {@code comparator()} method which returns the comparator<a name="line.28"></a>
<span class="sourceLineNo">029</span> * used to order the elements in this collection. Essentially this allows<a name="line.29"></a>
<span class="sourceLineNo">030</span> * another sorted collection of a desired type to create a copy of this<a name="line.30"></a>
<span class="sourceLineNo">031</span> * collection.<a name="line.31"></a>
<span class="sourceLineNo">032</span> * &lt;p&gt;<a name="line.32"></a>
<span class="sourceLineNo">033</span> * In addition all implementing classes are expected to provide three static<a name="line.33"></a>
<span class="sourceLineNo">034</span> * creation methods: {@code create()}, returning a collection that orders its<a name="line.34"></a>
<span class="sourceLineNo">035</span> * elements according to their &lt;i&gt;natural ordering&lt;/i&gt;,<a name="line.35"></a>
<span class="sourceLineNo">036</span> * {@code create(Comparator)} returning a collection which uses the specified<a name="line.36"></a>
<span class="sourceLineNo">037</span> * comparator to order its elements, and {@code create(Iterable)} returning a<a name="line.37"></a>
<span class="sourceLineNo">038</span> * collection containing the given initial elements. This is simply a refinement<a name="line.38"></a>
<span class="sourceLineNo">039</span> * of Java's constructor recommendations, reflecting the new developments of<a name="line.39"></a>
<span class="sourceLineNo">040</span> * Java 5.<a name="line.40"></a>
<span class="sourceLineNo">041</span> * <a name="line.41"></a>
<span class="sourceLineNo">042</span> * @author Zhenya Leonov<a name="line.42"></a>
<span class="sourceLineNo">043</span> * @param &lt;E&gt;<a name="line.43"></a>
<span class="sourceLineNo">044</span> *            the type of elements held in this collection<a name="line.44"></a>
<span class="sourceLineNo">045</span> */<a name="line.45"></a>
<span class="sourceLineNo">046</span>public interface SortedCollection&lt;E&gt; extends Collection&lt;E&gt; {<a name="line.46"></a>
<span class="sourceLineNo">047</span><a name="line.47"></a>
<span class="sourceLineNo">048</span>        /**<a name="line.48"></a>
<span class="sourceLineNo">049</span>         * Returns the comparator used to order the elements in this collection.<a name="line.49"></a>
<span class="sourceLineNo">050</span>         * Care must be taken when using &lt;i&gt;natural ordering&lt;/i&gt;. Implementations<a name="line.50"></a>
<span class="sourceLineNo">051</span>         * may choose to return a natural order comparator or {@code null}.<a name="line.51"></a>
<span class="sourceLineNo">052</span>         */<a name="line.52"></a>
<span class="sourceLineNo">053</span>        public Comparator&lt;? super E&gt; comparator();<a name="line.53"></a>
<span class="sourceLineNo">054</span><a name="line.54"></a>
<span class="sourceLineNo">055</span>}<a name="line.55"></a>




























































</pre>
</div>
</body>
</html>
